home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3s / mbrstring.z / mbrstring
Encoding:
Text File  |  2002-10-03  |  8.0 KB  |  133 lines

  1.  
  2.  
  3.  
  4. mmmmbbbbrrrrssssttttrrrriiiinnnngggg((((3333SSSS))))                                                    mmmmbbbbrrrrssssttttrrrriiiinnnngggg((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _mmmm_bbbb_rrrr_ssss_tttt_rrrr_iiii_nnnn_gggg: _mmmm_bbbb_ssss_rrrr_tttt_oooo_wwww_cccc_ssss, _wwww_cccc_ssss_rrrr_tttt_oooo_mmmm_bbbb_ssss - multibyte string functions
  10.      (restartable)
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_wwww_cccc_hhhh_aaaa_rrrr_...._hhhh_>>>>
  14.      _ssss_iiii_zzzz_eeee______tttt _mmmm_bbbb_ssss_rrrr_tttt_oooo_wwww_cccc_ssss _((((_wwww_cccc_hhhh_aaaa_rrrr______tttt _****_dddd_ssss_tttt_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_****_ssss_rrrr_cccc_,,,, _ssss_iiii_zzzz_eeee______tttt _nnnn_,,,, _mmmm_bbbb_ssss_tttt_aaaa_tttt_eeee______tttt
  15.      _****_pppp_ssss_))))_;;;;
  16.      _ssss_iiii_zzzz_eeee______tttt _wwww_cccc_ssss_rrrr_tttt_oooo_mmmm_bbbb_ssss _((((_cccc_hhhh_aaaa_rrrr _****_dddd_ssss_tttt_,,,, _cccc_oooo_nnnn_ssss_tttt _wwww_cccc_hhhh_aaaa_rrrr______tttt _****_****_ssss_rrrr_cccc_,,,, _ssss_iiii_zzzz_eeee______tttt _nnnn_,,,, _mmmm_bbbb_ssss_tttt_aaaa_tttt_eeee______tttt
  17.      _****_pppp_ssss_))))_;;;;
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      The _mmmm_bbbb_ssss_rrrr_tttt_oooo_wwww_cccc_ssss function converts a sequence of multibyte characters, from
  21.      the array indirectly pointed to by _s_r_c into a sequence of corresponding
  22.      wide character codes, and stores these codes into the array pointed to by
  23.      _d_s_t, stopping after _n codes are stored or a code with value zero (a
  24.      converted null character) is stored, if _d_s_t is not a null pointer.
  25.      Conversion stops in either of the following cases: when a sequence of
  26.      bytes is encountered that does not comprise a valid character, or when _n
  27.      converted codes have been stored into the array pointed to by _d_s_t which
  28.      is not a null pointer, or when the multibyte string including a null
  29.      character is converted completely and stored into the array.  If _d_s_t is a
  30.      null pointer, the value of _n is ignored, and the function returns the
  31.      number of characters required to convert the entire string. If _d_s_t is not
  32.      a null pointer, the pointer object pointed to by _s_r_c is assigned either a
  33.      null pointer if conversion stopped due to reaching a null character, or
  34.      the position just past the last character converted if any. If conversion
  35.      stopped due to reaching a null character and if _d_s_t is not a null
  36.      pointer, the conversion state is initialized.  If _p_s is a null pointer,
  37.      the _mmmm_bbbb_ssss_rrrr_tttt_oooo_wwww_cccc_ssss function uses its own internal mbstate_t object, which is
  38.      initialised at program startup. Otherwise, the mbstate_t object pointed
  39.      to by _p_s is used.
  40.  
  41.  
  42.      The _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss function converts a sequence of wide character codes, from
  43.      the array indirectly pointed to by _s_r_c into a sequence of multibyte
  44.      characters, and stores these multibyte characters into the array pointed
  45.      to by _d_s_t, stopping if a multibyte character would exceed the limit of _n
  46.      total bytes or if a null character is stored. If _d_s_t is a null pointer,
  47.      _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns the number of bytes required to convert the entire array
  48.      regardless of the value of _n, but no values are stored. If _d_s_t is not a
  49.      null pointer, the converted characters are stored into the array pointed
  50.      to by _d_s_t.  Conversion continues up to and including a null wide
  51.      character, which is also stored. Conversion stops in the following cases:
  52.      when a code is reached that does not correspond to a valid character, or
  53.      when the next character would exceed the limit of _n total bytes to be
  54.      stored in the array pointed to by _d_s_t which is not a null pointer, or
  55.      when the wide character string including a null wide character is
  56.      converted completely and stored into the array of the multibyte
  57.      characters.  If _d_s_t is not a null pointer, the pointer object pointed to
  58.      by _s_r_c is assigned either a null pointer if conversion stopped due to
  59.      reaching a null wide character or the address just past the last wide
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmbbbbrrrrssssttttrrrriiiinnnngggg((((3333SSSS))))                                                    mmmmbbbbrrrrssssttttrrrriiiinnnngggg((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      character converted if any. If conversion stopped due to reaching a null
  75.      wide character, the conversion state is initialized.  If ps is a null
  76.      pointer, the _wwww_cccc_ssss_rrrr_tttt_oooo_mmmm_bbbb_ssss function uses its own internal mbstate_t object.
  77.      Otherwise, the mbstate_t object pointed to by _p_s is used.
  78.  
  79.  
  80. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  81.      If an invalid multibyte character sequence is encountered, _mmmm_bbbb_ssss_rrrr_tttt_oooo_wwww_cccc_ssss
  82.      returns (_ssss_iiii_zzzz_eeee______tttt)-1 with _eeee_rrrr_rrrr_nnnn_oooo set equal to _EEEE_IIII_LLLL_SSSS_EEEE_QQQQ; the conversion state
  83.      is undefined.  Otherwise, it returns the number of characters converted
  84.      not including the terminating null code, if any.
  85.  
  86.      If a wide character code is encountered that does not correspond to a
  87.      valid multibyte character, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns (_ssss_iiii_zzzz_eeee______tttt)-1 with _eeee_rrrr_rrrr_nnnn_oooo set
  88.      equal to _EEEE_IIII_LLLL_SSSS_EEEE_QQQQ.  Otherwise, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns the number of bytes
  89.      modified, not including a terminating null character, if any.
  90.  
  91.  
  92. NNNNOOOOTTTTEEEESSSS
  93.      The behaviour of those functions is affected by the LC_CTYPE category of
  94.      the current locale.  (Stateful encodings are not supported on IRIX.)
  95.      Those functions are supported in n32 and 64 bit C Libraries for IRIX
  96.      6.5.17 and later versions.
  97.  
  98.  
  99. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  100.      _wwww_cccc_hhhh_rrrr_tttt_bbbb_llll(1M), _mmmm_bbbb_cccc_hhhh_aaaa_rrrr(3C), _mmmm_bbbb_ssss_tttt_rrrr_iiii_nnnn_gggg(3C), _mmmm_bbbb_rrrr_cccc_hhhh_aaaa_rrrr(3S), _ssss_eeee_tttt_llll_oooo_cccc_aaaa_llll_eeee(3C),
  101.      _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5), _<<<<_wwww_cccc_hhhh_aaaa_rrrr_...._hhhh_>>>>.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.